﻿/*----------------------------------------------------------------
//  <copyright file="ISmsTemplater.cs" company="MicroCloud@151504200868">
//      Copyright © 2020-2024 MicroCloud Corporation, All rights reserved.
//  </copyright>
//  <site>https://gitee.com/chenmm123/microclouds</site>
//  <last-editor>cmm</last-editor>
//  <last-date>2023-09-14 11:25</last-date>
//----------------------------------------------------------------*/

namespace MicroCloud.SMS.Templater
{
    #region "短信模板功能接口"
    /// <summary>
    /// 短信模板功能接口
    /// </summary>
    public interface ISmsTemplater
    {
        #region "方法"
        #region "申请短信模板"
        /// <summary>
        /// 申请短信模板
        /// </summary>
        /// <param name="paramsDto">短信模板参数DTO</param>
        /// <returns></returns>
        Task<OperationResult<TempResponse>> AddAsync(TempParamsDto paramsDto);
        #endregion
        #region "删除短信模板"
        /// <summary>
        /// 删除短信模板
        /// </summary>
        /// <param name="templateCode">短信模板CODE。您可以在控制台模板管理页面或API接口AddSmsTemplate的返回参数中获取短信模板CODE。</param>
        /// <returns></returns>
        Task<OperationResult<TempResponse>> DeleteAsync(string templateCode);
        #endregion
        #region "修改短信模板"
        /// <summary>
        /// 修改短信模板
        /// </summary>
        /// <param name="paramsDto">短信模板参数DTO</param>
        /// <returns></returns>
        Task<OperationResult<TempResponse>> ModifyAsync(TempParamsDto paramsDto);
        #endregion
        #region "查询短信模板"
        /// <summary>
        /// 查询短信模板
        /// </summary>
        /// <param name="templateCode">短信模板CODE。您可以在控制台模板管理页面或API接口AddSmsTemplate的返回参数中获取短信模板CODE。</param>
        /// <returns></returns>
        Task<OperationResult<TempDetailResponse>> QueryAsync(string templateCode);
        #endregion

        #endregion

    }
    #endregion

}
